home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / pinbrd12.zip / PINBOARD.DOC < prev    next >
Text File  |  1993-01-02  |  11KB  |  333 lines
  1.  
  2.                            PinBoard Designer V1.11
  3.                          (c) 1992 by Oliver Weindl
  4.                    Programmer's Inn 2:246/45 / 2:246/145
  5.             +49-8781-3418 / +49-8781-3442 both nodes with HST/DS
  6.  
  7.  
  8.  
  9.  
  10. 1) What's a Pinboard
  11.  
  12. A pinboard is an area, where your users can deposit messages to
  13. the other users. There are quite a lot of other so called logoff-
  14. note doors, but i know none, which can handle more than one
  15. logoff-note. This caused the problem, that one user entered a
  16. logoff-note, in which he asked for help on a special problem,
  17. and the next user just overwrote his question with an actual
  18. advertisment. With PinBoard your users can manage a News-file like
  19. the BBS-like news-files. Every note is put on the top of the pinboard,
  20. and the other notes are placed to the end. the last note in the pinboard
  21. will be erased (depends on how much notes you allow maximally).
  22.  
  23. PinBoard is shareware ! you may use this program as often as you like!
  24. If you register , you will receive a key-file which strips off the
  25. [unregisterd]-message and the pause after ending PinBoard.
  26. About registration look at the end of the text.
  27.  
  28.  
  29.  
  30. 2) What is needed
  31.  
  32. For PinBoard operation you need a BBS-Software, which can handle the
  33. DORINFO?.DEF files (almost every software can do this !).
  34. Also you have to change the settings in the PINBOARD.CTL file for
  35. your own purposes. PinBoard is multiline-aware, but you need one special
  36. CTL-file for every line (more about this later).
  37.  
  38. PinBoard generates two file snamed PINBOARD.ASC and PINBOARD.ANS.
  39. You can display this files via your bbs software (in SBBS it'for example
  40. the menutype 45). Most BBS-Software products can display a textfile
  41. automatically, SBBS uses the CTRL-A key for this problem.
  42.  
  43. How to display the PINBOARD.A?? file in SuperBBS:
  44.  
  45. You have to build a menu which will be started only at the login of
  46. an user. Let's call this menu AUTOMENU. Just start your menueditor
  47. for SBBS (io hope you use SEDIT ;-) and create a new menu with
  48. the name AUTOMENU. Insert one new entry, and edit this entry.
  49. Now change the Key of this entry to CTRL-A, and in the data-line of
  50. the entry write "PINBOARD" . Also set the security level for this entry
  51. to the lowest of your system, possibly zero.
  52. After that enter the CONFIG.EXE of SuperBBS and change the name of the
  53. first menu to AUTOMENU.MNU, so this menu will be called before your
  54. TOP.MNU.
  55.  
  56.  
  57. 3) The CTL-File
  58.  
  59.  
  60. The order of the keywords in the CTL-file is not important. Following
  61. there is a short description of the almost selfexplaining keywords.
  62.  
  63. Note! there i are more statements in the CTL file than explained here
  64. in the doc ! All of the statements are selfexplaining, so there is no
  65. need to explain them twice !
  66.  
  67. The configuration files have to placed in the PinBoard subdirectory.
  68.  
  69. Please Note : You may not place all pinboard files in the BBS-homedirectory,
  70. use an extra directory for pinboard (it's faster and looks better ;-)
  71.  
  72.  
  73. DORINFOPATH J:\SBBS\LINE1\
  74.  
  75. defines the path to the directory, where the DORINFO?.DEF files are
  76. placed. In multiline there are different paths for every line, so pay
  77. attention here !
  78.  
  79.  
  80. LINE 2
  81.  
  82. this keyword defines the number of the line you're running. If you're
  83. only running one line, you have to specify LINE 1, cause this statement
  84. defines the number of the DORINF?.DEF file !
  85. Don't erase this statement !
  86.  
  87. EXITINFOPATH J:\SBBS\LINE1\
  88.  
  89. with this option you can use some SBBS certain features. Also a few
  90. datas which are extracted from the DORINFO?.DEF file will be overwritten
  91. by the infos in EXITINFO.BBS. The main advantage of this feature is, that
  92. the time, spent in the door will be exactly given back to SBBS.
  93.  
  94.  
  95. MAXNOTES 3
  96.  
  97. how many notes should be managed ? define up to 99. The notes are
  98. managed in a ring-buffer, so if the number of notes exceed the statement
  99. here, the oldest one will be erased.
  100.  
  101.  
  102. TEXTPATH J:\SBBS\TEXT
  103.  
  104. defines the path to your BBS-textfiles. The output files of PinBoard
  105. (PINBOARD.ANS & PINBOARD.ASC) will be placed in this path.
  106.  
  107.  
  108. SAYSTRING $ says on % at & following
  109.  
  110. the SAYSTRING statement defines the context in the headerline above
  111. each note. there are some macros which will expand at runtime.
  112.  
  113.   $ expands to the full username
  114.   % expands to current date
  115.   & expands to current time
  116.  
  117.  
  118. CONTINUE Please press <ENTER> to continue...
  119.  
  120. defines the text, which will be displayed at the end of the pinboard-
  121. notes. the CTRL-A key (means the "wait-for-enter"-semaphore in the
  122. BBS-softwares) will be added automatically.
  123.  
  124.  
  125. INACTIVITY 300
  126.  
  127. After how many seconds user should be logged off by inactivity (default 300)
  128.  
  129.  
  130. LOGFILE J:\SBBS\LINE1\SYSTEM.LOG
  131.  
  132. Path and name of your logfile. If no logfile is defined, logging
  133. is disabled.
  134.  
  135.  
  136. 4) Multiline/Singleline operation
  137.  
  138. In multilinemode PinBoard shares the pinboard messages, and also the
  139. PIMBOARD.A?? files. Special semaphores prevent the other line to interfere
  140. in the actions of an other line.
  141.  
  142. PinBoard has several commandlineswitches which are explained below.
  143.  
  144.  
  145.   /G?            (? is 1 or 0) ansi/ascii switch
  146.   /C<filename>   <filename> name (without path) of an alternate
  147.                  configuration file (important for multiline)
  148.                  if nothing is defined, PINBOARD.CTL is used.
  149.   /DEBUG         run's PinBoard in Debugmode (only for testing!)
  150.  
  151.  
  152. When you install PinBoard in your BBS-Software you should
  153. use following statement:
  154.  
  155.  
  156. (sorry, i only can tell you how to do in SuperBBS, cause i use it ;-)
  157.  
  158. Place a menutype 7 (shell under board an run program) in one of
  159. your menus.
  160.  
  161. the command line for single-line is quite simple:
  162.  
  163. in SuperBBS use:
  164.  
  165.    J:\SBBS\PINBOARD\PINBOARD.EXE /G*G *E
  166.  
  167. *E = read exitinfo after return to BBS
  168. *G = Ansi-macro of SuperBBS (*G expands to 0 or 1 !)
  169.  
  170. Note : PINBOARD.CTL in J:\SBBS\PINBOARD\ is used !
  171.  
  172.  
  173. the commandline for mutliline operation is quite longer.
  174.  
  175. in SuperBBS use:
  176.  
  177.    J:\SBBS\PINBOARD\PINBOARD.EXE /G*G /CPINBRD*N.CTL *E
  178.  
  179. *E = read exitinfo after return to BBS
  180. *G = Ansi-macro of SuperBBS (*G expands to 0 or 1 !)
  181. *N = Number of actual line in SuperBBS
  182.  
  183. the parameter /CPINBRD*N.CTL will expand to
  184.  
  185.   /CPINBRD1.CTL on line 1
  186.   /CPINBRD2.CTL on line 2 and so on.
  187.  
  188. You have to place a PINBRD?.CTL for every line in the PinBoard-directory !
  189.  
  190.  
  191. For Remote Abszess (sorry) Access use following lines:
  192. (Thanx to Klaus-Dieter Klein 2:246/126 for the text)
  193.  
  194. Installing in a RemoteAccess Environment:
  195.  
  196. Place a menutype 7 (shell under board an run program) in one of
  197. your menus.
  198.  
  199. the command line for single-line is quite simple:
  200.  
  201. in RemoteAccess use:
  202.  
  203.    C:\COMMAND.COM /C J:\RA\PINBOARD\PINBOARD.EXE -G1 *M
  204.  
  205. C:\COMMAND.COM /C = a second Command-Interpreter will be loaded
  206.                     during run of PINBOARD.EXE (speeding up!)
  207. *G                = Ansi-macro of SuperBBS (*G expands to 0 or 1 !)
  208. *M                = Swapping of RA into Extended Memory during
  209.                     run of PINBOARD.EXE
  210.  
  211. Note : PINBOARD.CTL in J:\RA\PINBOARD\ is used !
  212.  
  213.  
  214. the commandline for mutliline operation is quite longer.
  215.  
  216. in RA use:
  217.  
  218.    C:\COMMAND.COM /C J:\RA\PINBOARD\PINBOARD.EXE -G1 /CPINBRD*N.CTL *M
  219.  
  220. C:\COMMAND.COM /C = a second Command-Interpreter will be loaded
  221.                     during run of PINBOARD.EXE (speeding up!)
  222. *G                = Ansi-macro of SuperBBS (*G expands to 0 or 1 !)
  223. *N                = Number of actual line in RA
  224.  
  225. the parameter /CPINBRD*N.CTL will expand to
  226.  
  227.   /CPINBRD1.CTL on line 1
  228.   /CPINBRD2.CTL on line 2 and so on.
  229.  
  230.  
  231.  
  232. 5) Global features of PinBoard
  233.  
  234. There exists one file in the PinBoard-package which is called PINBOARD.HLP.
  235. This file is a plain vanilla ASCII-File which contains a short help for
  236. your users. Simply edit this file with an ASCII-Editor for your individual
  237. help-screen.
  238.  
  239. In SysOp-mode (already known as god-mode ;-) you see some information
  240. on the last to lines of your screen (don't worry, 43 lines and 50 lines
  241. screens are supported ;-).
  242.  
  243. There is one status-statement which is not very common in use, the
  244. "Countdown"-statement. It describes the seconds until an inactivity
  245. logout is processed.
  246.  
  247. With the Cursor up/down keys you can increase/decrease users time left
  248. If you use EXITINFO.BBS, this time will be retruned to your BBS Software.
  249.  
  250.  
  251. 6) Requirements
  252.  
  253. PinBoard requires a fossil-device which should be loaded and already
  254. configured.
  255.  
  256. Normaly you don't need to swap your BBS-software to disk or EMS, PinBoard
  257. won't use so much memory.
  258.  
  259. PinBoard also requires a BBS-software which produces a DORINFO1.DEF (and
  260. in multiline a DORINFO?.DEF) file. Without this file no operation is
  261. possible !
  262.  
  263. An Ansi-device is not necessary, cause PinBoard translates the Ansi-commands
  264. to direct screen-writes.
  265.  
  266.  
  267.  
  268. 7) Registration
  269.  
  270. The fee for PinBoard is (for Version 1.11) 15 US $ or 15 German Marks.
  271.  
  272. There are two way's of registration:
  273.  
  274. per email :    send a letter with cash/eurocheque to the registration
  275.                adress below. Add 5 US$ or 5 German Marks if i should
  276.                send you the key crash to your BBS ! Otherwise the key
  277.                will be put on hold for your system.( Point-Systems !
  278.                please add 5$/German Marks, so that i can send the
  279.                key to your boss, cause i cannot put it on hold for
  280.                points !)
  281.  
  282. per snailamil: Transfer the money like above. Add a already adressed
  283.                envelope (don't forget the stamp !) with a formatted
  284.                disk in the letter. You will recieve the lates version
  285.                of PinBoard and a valid key per snailmail.
  286.  
  287. If you transfer money by bank-transfer, please inform me about this per
  288. email (or a local mail in my bbs ) !!!
  289.  
  290.  
  291. !!! Important !!!
  292.  
  293. If the package is not complete, e.g. you forget the stamp, or insert no
  294. disk etc.. i WILL NOT do anything ! 15$ (German Marks) are not the world,
  295. so please understand this !
  296.  
  297.  
  298.  
  299.                                ******
  300.  
  301. For key-generation i need the full name of your mailbox (case sensitiv !).
  302.  
  303.                                ******
  304.  
  305. SnailMail-Adress :          Oliver Weindl
  306.                             Sudetenstr.3
  307.                     Germany 8303 Rottenburg/L   
  308.  
  309. EMail            :          Oliver Weindl 2:246/45@Fidonet.org
  310.  
  311. Bank-Transfer    :          Sparkasse Rottenburg
  312.                             BLZ   743 500 50
  313.                             Ktnr. 701 493 7
  314.  
  315. 8) Future releases
  316.  
  317. All future releases can be frequested at 2:246/45 and 2:246/145 with
  318. the magic PINBOARD. For those who aren't in Fido call this board
  319. with your terminal, phone: +49-8781-3418 & +49-8781-3442, line one
  320. with HST/DS. Line 2 now with ZyXEL + !!
  321.  
  322.  
  323. Improvements will regard on the reactions i receive on this program.
  324.  
  325.  
  326. Please write your opinion about this program to : Oliver Weindl 2:246/45
  327.  
  328.  
  329.  
  330.                                                Oliver Weindl
  331.                                                2:246/45
  332.                                                6.September 1992
  333.